Package com.cisco.pt.ipc.sim
Interface AsaObject
- All Superinterfaces:
IPCObject
- All Known Implementing Classes:
AsaObjectImpl
Information provided by the PKI file:
\class CAsaObject
\brief CAsaObject is the asa object storage manager class that is used to store and retrieve asa object.
\example network().getDevice("Router0").getObjectManager()->getObjectByName("objectName")
- Author:
- Auto-generated
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddReferenceObject(String reference) Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:booleanInformation provided by the PKI file:voidremoveReferenceObject(String reference) Information provided by the PKI file:voidsetDescription(String description) Information provided by the PKI file:voidsetObjectName(String objectName) Information provided by the PKI file:toString()Information provided by the PKI file:Methods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Method Details
-
getObjectName
String getObjectName()Information provided by the PKI file:
\brief Return the asa object name \return string, value is the asa object name.- Returns:
- String Returns a String
-
setObjectName
Information provided by the PKI file:
\brief Return the asa object name \param objectName, value is the name to give the object.- Parameters:
objectName- Takes in a parameter of objectName
-
getObjectType
ObjectType getObjectType()Information provided by the PKI file:
\brief Return the asa object type type - asa object type, values: eNetwork = 0, eService = 1, eGroupService = 2, eGroupServiceTcp = 3, eGroupServiceUdp = 4, eGroupServiceTcpUdp = 5, eGroupNetwork = 6, eWebvpn = 7 \return ObjectType, value is the asa object type.- Returns:
- ObjectType Returns a ObjectType
-
getDescription
String getDescription()Information provided by the PKI file:
\brief Return the asa object description \return string, value is the description.- Returns:
- String Returns a String
-
setDescription
Information provided by the PKI file:
\brief Set the description of the asa object \param description, value is the description to use for the object.- Parameters:
description- Takes in a parameter of description
-
isReferenced
boolean isReferenced()Information provided by the PKI file:
\brief Check to see if the asa object is being used by other classes \return bool, Value is true if the asa object is being used by other classes, false if not.- Returns:
- boolean Returns a boolean
-
addReferenceObject
Information provided by the PKI file:
\brief Any class that has reference to the asa object calls this function to confirm its association with the object \param reference, a unique string to identify which object that has association with the asa object- Parameters:
reference- Takes in a parameter of reference
-
removeReferenceObject
Information provided by the PKI file:
\brief Any class that has reference to asa object calls this function to release its association with the object \param reference, a unique string to identify which object that has association with the asa object- Parameters:
reference- Takes in a parameter of reference
-
toString
String toString()Information provided by the PKI file:
\brief Return the string configuration of the asa object \return string, value is the string configuration of the asa object. -
getObjectServiceTypeString
String getObjectServiceTypeString()Information provided by the PKI file:
\brief Return the string configuration for object-group of service type \return string, value is the string configuration for object-group of service type.- Returns:
- String Returns a String
-